Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add concise and detailed logs for missing or inconsistent voltage levels limits. #68

Merged
merged 3 commits into from
May 16, 2024

Conversation

FranckLecuyer
Copy link
Contributor

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?

What kind of change does this PR introduce?

Feature

What is the current behavior?

When there are voltage levels without limits, and also when there are inconsistencies in the limits (limit < 0 or low limit > high limit),
an exception is just thrown, and we have no information about the concerned voltage levels.

What is the new behavior (if this is a feature change)?
Synthetic and detailed reports are now created for missing or inconsistent voltage levels limits, before the exception is thrown, in order to help the user to correct his data.

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

Other information:

Add synthetic and detailed logs for inconsistent voltage levels limits (limit < 0 and low limit > high limit)

Signed-off-by: Franck LECUYER <[email protected]>
@FranckLecuyer FranckLecuyer requested a review from So-Fras April 26, 2024 11:05
Copy link
Member

@So-Fras So-Fras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this feature. I made some comments and there are new code smells too, mainly about maintainability. Is it possible to refactor the methods mentioned by Sonar?

@So-Fras So-Fras changed the title Add synthetic and detailed logs for missing or inconsistent voltage levels limits. Add concise and detailed logs for missing or inconsistent voltage levels limits. May 13, 2024
Signed-off-by: Franck LECUYER <[email protected]>
Signed-off-by: Franck LECUYER <[email protected]>
Copy link

@FranckLecuyer
Copy link
Contributor Author

Thanks for adding this feature. I made some comments and there are new code smells too, mainly about maintainability. Is it possible to refactor the methods mentioned by Sonar?

Refactoring done to remove sonar issues.

@FranckLecuyer FranckLecuyer requested a review from So-Fras May 13, 2024 15:47
@So-Fras So-Fras merged commit 0f4983e into main May 16, 2024
6 checks passed
@So-Fras So-Fras deleted the log_missing_or_incorrect_voltage_level_limits branch May 16, 2024 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants